Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update docs #1370

Merged
merged 3 commits into from
Apr 15, 2021
Merged

update docs #1370

merged 3 commits into from
Apr 15, 2021

Conversation

dsyme
Copy link
Contributor

@dsyme dsyme commented Apr 15, 2021

Fixes the issues in #1368

Also move some docs from non-standard markdown to standard XML

Note the fsdocs sidebar has moved the left by default. I'm also thinking we should change the default fsdocs template to position it more like DiffSharp does than all the way to the left as the default is now doing. (I'd like to keep using the FSharp.Formatting default template so we can keep making improvements there)

@dsyme dsyme merged commit d6978d4 into fsprojects:master Apr 15, 2021
dsyme added a commit that referenced this pull request Apr 15, 2021
@nhirschey
Copy link
Contributor

Strong second of a sidebar along the lines of the diffsharp docs template.

I’ve been meaning to raise an issue, but if you’re on a mobile browser then clicking the sidebar on the current template fills the browser window with the sidebar, and that sidebar menu that pops out is not scrollable. So it’s impossible (at least on iOS) to scroll to and click on links at the bottom of the side bar. You’re restricted to the first few items on the sidebar. In below screenshot, I can’t access anything below XML Provider.

Diffsharp has sidebar links at the top on mobile, which makes it scrollable.
6D28F68B-A623-4FDA-8211-F90C37CABBB4

@dsyme
Copy link
Contributor Author

dsyme commented Apr 15, 2021

I think the problem is that the intention is that the nav bar is scrollable and fixed-location (which works on desktop). And the DiffSharp one has no hamburger on mobile

Anyway could you file an issue in FSharp.Formatting? Thanks

@dsyme
Copy link
Contributor Author

dsyme commented Apr 15, 2021

Anyway could you file an issue in FSharp.Formatting? Thanks

(The same issue applied to the FSharp.Formatting site AFAIK)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants